<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>CharacteristicProps | hap-nodejs</title>
	<meta name="description" content="Documentation for hap-nodejs">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
	<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">hap-nodejs</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../modules.html">hap-nodejs</a>
				</li>
				<li>
					<a href="characteristicprops.html">CharacteristicProps</a>
				</li>
			</ul>
			<h1>Interface CharacteristicProps</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">CharacteristicProps</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#adminonlyaccess" class="tsd-kind-icon">admin<wbr>Only<wbr>Access</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#description" class="tsd-kind-icon">description</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#format" class="tsd-kind-icon">format</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#maxdatalen" class="tsd-kind-icon">max<wbr>Data<wbr>Len</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#maxlen" class="tsd-kind-icon">max<wbr>Len</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#maxvalue" class="tsd-kind-icon">max<wbr>Value</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#minstep" class="tsd-kind-icon">min<wbr>Step</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#minvalue" class="tsd-kind-icon">min<wbr>Value</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#perms" class="tsd-kind-icon">perms</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#unit" class="tsd-kind-icon">unit</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#validvalueranges" class="tsd-kind-icon">valid<wbr>Value<wbr>Ranges</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="characteristicprops.html#validvalues" class="tsd-kind-icon">valid<wbr>Values</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="adminonlyaccess" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> admin<wbr>Only<wbr>Access</h3>
					<div class="tsd-signature tsd-kind-icon">admin<wbr>Only<wbr>Access<span class="tsd-signature-symbol">:</span> <a href="../enums/access.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Access</a><span class="tsd-signature-symbol">[]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L373">lib/Characteristic.ts:373</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="description" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
					<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L344">lib/Characteristic.ts:344</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="format" class="tsd-anchor"></a>
					<h3>format</h3>
					<div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L341">lib/Characteristic.ts:341</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="maxdatalen" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Data<wbr>Len</h3>
					<div class="tsd-signature tsd-kind-icon">max<wbr>Data<wbr>Len<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L363">lib/Characteristic.ts:363</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Maximum number of characters when format is <a href="../enums/formats.html#data">Formats.DATA</a>.
							Default is 2097152 characters.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="maxlen" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Len</h3>
					<div class="tsd-signature tsd-kind-icon">max<wbr>Len<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L358">lib/Characteristic.ts:358</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Maximum number of characters when format is <a href="../enums/formats.html#string">Formats.STRING</a>.
							Default is 64 characters. Maximum allowed is 256 characters.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="maxvalue" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Value</h3>
					<div class="tsd-signature tsd-kind-icon">max<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L352">lib/Characteristic.ts:352</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Defines the maximum value for a numeric characteristic</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="minstep" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Step</h3>
					<div class="tsd-signature tsd-kind-icon">min<wbr>Step<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L353">lib/Characteristic.ts:353</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="minvalue" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Value</h3>
					<div class="tsd-signature tsd-kind-icon">min<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L348">lib/Characteristic.ts:348</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Defines the minimum value for a numeric characteristic</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="perms" class="tsd-anchor"></a>
					<h3>perms</h3>
					<div class="tsd-signature tsd-kind-icon">perms<span class="tsd-signature-symbol">:</span> <a href="../enums/perms.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Perms</a><span class="tsd-signature-symbol">[]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L342">lib/Characteristic.ts:342</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="unit" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> unit</h3>
					<div class="tsd-signature tsd-kind-icon">unit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L343">lib/Characteristic.ts:343</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="validvalueranges" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> valid<wbr>Value<wbr>Ranges</h3>
					<div class="tsd-signature tsd-kind-icon">valid<wbr>Value<wbr>Ranges<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L372">lib/Characteristic.ts:372</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Two element array where the first value specifies the lowest valid value and
							the second element specifies the highest valid value.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="validvalues" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> valid<wbr>Values</h3>
					<div class="tsd-signature tsd-kind-icon">valid<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/homebridge/HAP-NodeJS/blob/95a2490/src/lib/Characteristic.ts#L367">lib/Characteristic.ts:367</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Defines a array of valid values to be used for the characteristic.</p>
						</div>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class=" ">
						<a href="../modules.html">Exports</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface">
						<a href="characteristicprops.html" class="tsd-kind-icon">Characteristic<wbr>Props</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#adminonlyaccess" class="tsd-kind-icon">admin<wbr>Only<wbr>Access</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#description" class="tsd-kind-icon">description</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#format" class="tsd-kind-icon">format</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#maxdatalen" class="tsd-kind-icon">max<wbr>Data<wbr>Len</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#maxlen" class="tsd-kind-icon">max<wbr>Len</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#maxvalue" class="tsd-kind-icon">max<wbr>Value</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#minstep" class="tsd-kind-icon">min<wbr>Step</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#minvalue" class="tsd-kind-icon">min<wbr>Value</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#perms" class="tsd-kind-icon">perms</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#unit" class="tsd-kind-icon">unit</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#validvalueranges" class="tsd-kind-icon">valid<wbr>Value<wbr>Ranges</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="characteristicprops.html#validvalues" class="tsd-kind-icon">valid<wbr>Values</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer>
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>